home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 12 / Cream of the Crop 12 (Part II) / Cream of the Crop 12 (Part II).iso / OS2 / NEMO10.ZIP / nemo.doc < prev    next >
Encoding:
Text File  |  1996-02-06  |  36.2 KB  |  855 lines

  1.  
  2.             Captain Nemo for OS/2
  3.              Version 1.0   February 1996
  4.  
  5.           Copyright (C) 1993-1996 by Adam Mirowski
  6.  
  7. Introduction
  8. ------------
  9.  
  10. "Captain Nemo" is a text-mode shell program for OS/2. It tries to
  11. imitate Norton Commander (R) for DOS as closely as possible while
  12. providing access to OS/2 specific features. I started writing it in
  13. March 1993 after buying NC for OS/2 and losing the hopes I have
  14. initially put in this product (it has since been discontinued).
  15. The reference version of Norton Commander was initially 2.0, but this
  16. is changing towards compatibility with 4.0.
  17.  
  18. This version 1.0 is the fourth release. I have incremented the major
  19. version number given the significant increase in feature it provides.
  20. It is less incomplete, less buggy, very usable in fact. I have still
  21. left all the internal checks that slow down execution and waste memory
  22. somewhat, since they prevent disasters and provide an important level of
  23. confidence.
  24.  
  25. Unlike the first two releases, this one is no longer freeware. If you
  26. use Captain Nemo regularly, you are required to pay a donation, 20 US
  27. dollars or 150 French franks, to the author.
  28.  
  29. Captain Nemo version 1.0 is distributed in the hope that it will be
  30. useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
  31. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. You can use at your
  32. own risk, and report whatever problems you have encountered with it.
  33. You are free to copy this software ONLY if you include this document
  34. file with it. You may NOT charge anyone for a copy of this software
  35. other than a small copying fee. You may NOT include this software with
  36. any commercial software without the written consent of the author.
  37.  
  38. You can contact me either by writing an e-mail to:
  39.  
  40.     Adam Mirowski <mir@chorus.fr>
  41.  
  42. or sending a letter to:
  43.  
  44.     Adam Mirowski
  45.     Residence Les Cypres
  46.     10, rue Caruel de Saint-Martin
  47.     F-78150 Le Chesnay
  48.     FRANCE
  49.  
  50. You can phone me at +33 (1) 30-64-82-74 (business) or +33 (1)
  51. 39-54-27-34 (home). Please note that I live in the GMT+2 time zone.
  52.  
  53. If you want to submit a bug report, notably about a failing assert, note
  54. that Nemo allows to save the current screen content (as left by previously
  55. executed external commands, Nemo itself for example) to a file, from the
  56. Editor, using the ^KM (Ctrl-K-M) key combination.
  57.  
  58. The time has shown that for money transfers, sending US or convertible
  59. (Deutsche Marks, Guldens, Swiss Franks, etc.) cash in an envelope is the
  60. most cost-effective way, and even unofficially recommended by my bank.
  61. You may send checks in French franks drawn on a French bank. Eurocheques
  62. (in French franks) will work very fine. You can also use postal fund
  63. transfer methods, eg. International Money Orders, which are very cheap.
  64. Please avoid sending checks in foreign currencies, since they cost me
  65. about $17 to cash :-(.
  66.  
  67. Features
  68. --------
  69.  
  70. At this time, Captain Nemo has all Norton Commander v.2 features. It
  71. also has a lot of v.3 and v.4 features: operations on directory
  72. trees, compressed archives support, extended internal editor, Quick view,
  73. shadows, etc. although the layout of several message and dialog boxes is
  74. still somewhat v.2.
  75.  
  76. Modifications since the previous released versions are listed in the
  77. "whats-up.doc" file.
  78.  
  79. These features are special to Captain Nemo compared to NC v.4:
  80.  
  81.     Transparent archive handling
  82.     ----------------------------
  83.     Archive handling is transparent. There is no special "Compressed file"
  84.     panel type which limits you to a single vision of the archives. Instead,
  85.     archives are transparently mounted onto the filesystem. This occurs when
  86.     you try to set the current directory inside them, ie. enter them, for
  87.     example using the Enter or Ctrl-PageDown keys from the command line. From
  88.     that moment, archives are considered as directories and not as files
  89.     anymore, until you un-mount them.
  90.  
  91.     Therefore, all Nemo operations can apply to archives, and you are not
  92.     limited to copy/move/view operations. I called this technology "Nemo
  93.     file-system", "Nemo FS" in shortcut. Look for more description in
  94.     "whats-up.doc" file.
  95.  
  96.     Nemo supports additional archive formats:
  97.     - OS/2 unpack (all versions since OS/2 1.0)
  98.     - GZIP
  99.     - UNIX ls(1) recursive directory listing and
  100.     - FTP site seamless access.
  101.  
  102.     Indeed, it is possible to create a file describing an FTP site and
  103.     later "enter" this file as if it was a local directory. This gives
  104.     an illusion of an NFS connection with any FTP site in the world.
  105.     Of course, it works best in a Local Area Network environment. See
  106.     the nemo-os2.arv file for information about the format of the
  107.     files describing FTP sites.
  108.  
  109.     Parsing of all archive formats is handled internally. External tools
  110.     are invoked to perform file operations themselves.
  111.  
  112.     Since Nemo considers archives as sub-directories, it is possible to
  113.     create empty archives using Shift-F7 (this key combination was equivalent
  114.     to F7 in previous versions and still is in native NC). ARC, ARJ, FTP,
  115.     GZIP, LZH and ZIP formats are available. Newly created empty archives
  116.     are not automatically mounted, but the selection bar is placed over
  117.     them just like for ordinary directories. Note that the FTP creation
  118.     function is mostly there to allow you to enter the password and encode
  119.     it, so that people looking at the files on your computer cannot see
  120.     your passwords. After creating an .FTP file, you will need to put
  121.     an FTP site address inside, using the popular ftp://host/dir/file
  122.     notation.
  123.  
  124.     To increase performance, Nemo maintains a cache of extracted files,
  125.     located by default in C:\nemo. You can change this location using
  126.     F9/O/"Archive cache", as long as no archives are mounted. You can
  127.     unmount all mounted archives using F10/U. Do not try to manipulate
  128.     the archive cache content directly using Nemo when archives are
  129.     mounted, since at that time it is a totally "warped" place. You can
  130.     destroy the cache content, selectively or not, if it grows too big,
  131.     once you have unmounted the archives.
  132.  
  133.     Invocations of external archiver programs are constructed according to
  134.     the directions contained in the nemo-os2.arv file. This text file can
  135.     be edited using any editor, notably using the F9/C/R key sequence.
  136.     When the .ARV file is updated through F9/C/R, Nemo automatically
  137.     updates its internal tables after exiting from the editor. The ARV
  138.     file contains a detailed explanation of its format.
  139.  
  140.     See the separate chapter below on the level of support of each
  141.     archive format.
  142.  
  143.     File attribute editing
  144.     ----------------------
  145.     * It is possible to edit the date and time of files and groups of files
  146.     * and to see OS/2 Extended Attributes of files.
  147.     * The dialog box is quickly accessible through the Alt-F11 hot key.
  148.  
  149.     * Ctrl+cursor movement keys allow to slide the dialog over files in
  150.       a directory, for example to see their EAs.
  151.     * Ctrl-Ins will tag the current file and reopen the dialog, still in
  152.       single file mode.
  153.  
  154.     Support for HPFS and long-name CD-ROMs
  155.     --------------------------------------
  156.     * There is a specific "long names" directory format for HPFS disks,
  157.       allowing up to 16 visible chars on 80 char wide displays and up to
  158.       38 on 132 char wide displays.
  159.     * It is also used in the logical naming mode (see below).
  160.     * The mini-status can display more chars if necessary, 38 or 64.
  161.     * HPFS panels can be put into a FAT-looking mode, where they put
  162.       filenames to lowercase (F9/O/O).
  163.  
  164.     * The CD-ROM directory format is similar, except that the FAT case
  165.       convention is used: filenames are displayed in lower case and
  166.       directory names in upper case.
  167.  
  168.     WPS logical file naming using .LONGNAME extended attributes
  169.     -----------------------------------------------------------
  170.     It is possible to enter a "logical naming" mode using Alt-F5 or
  171.     the menu (F9/C/L). In this mode, files can be identified and manipulated
  172.     using arbitrary logical names rather than hardware 8.3 FAT names.
  173.     This makes FAT disks appear like HPFS ones, and is also compatible
  174.     with the Workplace Shell naming (you can rename each other's objects
  175.     using alternatively Nemo and WPS). Ctrl-F11 creates a logical name
  176.     for the current file.
  177.  
  178.     descript.ion file handling
  179.     --------------------------
  180.     * Nemo automatically updates 4DOS/4OS2 descript.ion files with file
  181.       descriptions as files are copied, moved, renamed or deleted.
  182.  
  183.     * descript.ion files are supported in archives.
  184.  
  185.     * descript.ion files are visible in directory panels and can be viewed,
  186.       edited, copied, moved or deleted. They cannot be tagged. They are
  187.       invisible to all global file operations, as Nemo updates their content
  188.       by itself and asynchronously.
  189.  
  190.     Task switcher
  191.     -------------
  192.     * Nemo offers a simple text mode task switcher, which allows you to
  193.       visualize sessions, switch to another one or kill it (using the
  194.       DEL key over the entry) without passing through the PM and its
  195.       graphic mode.
  196.  
  197.     OS/2 extended-attribute support
  198.     -------------------------------
  199.     * Extended attributes follow owning files and directories when those
  200.       are copied or moved.
  201.     * Editing a file does not make it lose its extended attributes.
  202.  
  203.     Quick view
  204.     ----------
  205.     * If the selection is scrolled onto an archive, instead of being displayed
  206.       after a timeout, the archive is mounted and directory-like information
  207.       (files, subdirs and bytes) is displayed for it.
  208.  
  209.     * For ordinary directory, the Quick Panel also displays the size of the
  210.       slack space wasted by files, and the percentage this makes of the total
  211.       space occupied by files.
  212.  
  213.     * For archives, the Quick Panel also displays:
  214.       - the savings due to compression ("Virt save") and
  215.       - combined savings due to compression and slack elimination ("Real save")
  216.  
  217.     132 column display support
  218.     --------------------------
  219.     * Activated through Alt-F6 or F9/C/O. Nemo tries to keep the current
  220.       number of screen lines during this operation. Similarly, when you
  221.       use Alt-F9 or F9/C/E to switch the number of lines on screen, Nemo
  222.       tries to keep the number of screen columns.
  223.  
  224.     Extension file (associations)
  225.     -----------------------------
  226.     * It can have an unlimited length, while NC is limited to 30 entries.
  227.       My DOS nc.ext which I use with the DOS version of Nemo has over 90
  228.       entries! The additional "!*" escape allows to pass the list of currently
  229.       tagged files to the command executed.
  230.  
  231.     * Ctrl-PageDown allows to preview the command which will be executed if
  232.       Enter (or Shift-Enter) is pressed over a file entry in a Directory
  233.       Panel. The expanded command is put into the command line and the
  234.       cursor is placed at the end of it. Note that if the entry is a
  235.       directory, this directory will still be entered, and if the entry is
  236.       an archive, this archive will be mounted and entered.
  237.  
  238.     User menus
  239.     ----------
  240.     * Commands executed from the user menu can be optionally echoed to the
  241.       command history, for easy recall (for example using Ctrl-E) and re-
  242.       execution after possible modification. This is enabled on a per-command
  243.       basis by using a double semicolon ("::") instead of a single semi-
  244.       colon (":") as separator between command hotkey and command title.
  245.       Eg.
  246.         F2::    Make Default        <- note the double ::
  247.             make -fmakefile
  248.  
  249.         F10:    Reboot the machine    <- note the single :
  250.             reboot
  251.  
  252.     * Ctrl-Enter allows to paste the menu command into the command line
  253.       instead of directly executing it. Note: when several commands are
  254.       associated with a menu entry only the first one is pasted.
  255.  
  256.     Viewer
  257.     ------
  258.     Quite extended compared to NC built-in viewer, but not "quite" as
  259.     powerful as the family of viewers provided with NC. If we compare
  260.     the built-in viewers, Nemo:
  261.  
  262.     * allows to properly view Unix text files,
  263.     * offers a hex mode (F4),
  264.     * a "prefix" mode (F3) which displays control and non-printable bytes
  265.       as "^X" control sequences and is interesting for seeing tabulations,
  266.       line terminations and for examining Unix terminal control sequences.
  267.       I actually added this mode when developping the first Unix version of
  268.       Nemo.
  269.     * allows to append the current screen content to a file (F5), and
  270.     * to go to an arbitrary offset in file (F6, Alt-F8).
  271.     * saves the position in the 16 last viewed files, so when they are
  272.       viewed again, it brings them to the last position.
  273.     * files previously viewed can be re-opened from a list either from
  274.       View itself (Alt-F3) or from the main screen (Shift-F12, F9/C/V).
  275.     * Alt-F5 shows the background "behind panels". This allows to peek at
  276.       the results of the last command.
  277.     * Shift combined with arrow keys allows to switch to another file in
  278.       the current directory. Ctrl+Ins allows to tag the file and go to
  279.       the next one.
  280.  
  281.     * The viewer can be set to an external executable (F9/O/V)
  282.     * The "!*" escape allows to pass it the list of tagged files in the
  283.       current directory panel.
  284.  
  285.     Editor
  286.     ------
  287.     * File size and line lengths are only limited by the available virtual
  288.       memory.
  289.     * Nemo proposes to make a file writable and to retry if Save fails.
  290.     * Nemo makes sure that edited files are fully backed in \DELETE if you
  291.       have this enabled at OS/2 level.
  292.     * Blocks can start and end in the middle of lines and are fully persistent
  293.       once boundaries have been set: it is possible to edit the text inside
  294.       and outside.
  295.     * The basic set of block commands is Wordstar/Borland compatible and based
  296.       around the ^K escape, which does not "kill till eol" like in NC editor
  297.       and earlier Nemo version anymore. Use ^KN for that.
  298.     * Some CUA block commands (Shift+key) are supported as well. The
  299.       "whats-up.doc" file details all the commands.
  300.     * A clipboard, either internal or the Opearating System's one allows to
  301.       move data between files, or to export/import to/from outside.
  302.     * Auto-indent mode with optimal fill (Alt-I).
  303.     * The position in 16 last edited files is saved and restored when one
  304.       of these files is re-opened.
  305.     * Files previously edited can be re-opened either from Edit itself
  306.       (Alt-F3) or from the main screen (Ctrl-F12, F9/C/A).
  307.  
  308.     * Alt-F5 shows the background "behind panels". This allows to peek at
  309.       the results of the last command.
  310.     * Can insert this background into the edited text (^KM).
  311.     * Keybar can be disabled (^B) to increase the number of visible lines.
  312.       This setting is saved into the config file.
  313.     * Terminating EOF characters are stripped from files, even if there are
  314.       several of them.
  315.  
  316.     History
  317.     -------
  318.     * History elimination is case-sensitive. For strange reasons, NC
  319.       even in version 5.0 considers that for example "/c" and "/C" are
  320.       the same option for a command and stores only one copy of it.
  321.       
  322.     * Future version may include a cache-style history, which holds
  323.       only one copy of a command.
  324.  
  325.     Directory panels
  326.     ----------------
  327.     * The Grey* key allows inverting the selection of files.
  328.     * F9/O/N toggles case-sensitive or insensitive sorting of files.
  329.     * Ctrl-F8 toggles the reverse mode for sorting.
  330.     * Ctrl-R can be made compatible with NC v.2 where it opens the
  331.       "Drive letter" dialog (F9/O/D) instead of re-reading the directory.
  332.  
  333.     * Shift-LeftArrow and Shift-RightArrow allow to select files (or rather
  334.       to invert their selection status) like you would select lines in a
  335.       CUA-compatible text editor. This is in addition to the Ins key. In
  336.       many environments, the Shift-arrow keys have the advantage of being
  337.       auto-repetitive, unlike the Ins key.
  338.  
  339.     Last directories cache
  340.     ----------------------
  341.     * Nemo saves the pathnames of the 16 last-visited dirs.
  342.     * It stores a directory if a file has been edited or viewed inside,
  343.       or if a command has been executed there. It also stores the root
  344.       dirs of all recently mounted archives.
  345.  
  346.     * The cache is accessible through Alt-F12 or F9/C/D, titled "Last
  347.       directories", and can be used similarly to the command history
  348.       (selection with cursor keys and by initial).
  349.  
  350.     File operations
  351.     ---------------
  352.     * When files are copied or moved from HPFS to FAT partitions, filenames
  353.       which do not fit the 8.3 convention are automatically and intelligently
  354.       shortened and the original name is saved under the .LONGNAME extended
  355.       attribute.
  356.  
  357.     * Read-only attributes are not copied from CD-ROMs.
  358.  
  359.     File finder
  360.     -----------
  361.     * Can locate files in archives, thanks to Nemo FS. This is toggled using
  362.       F9/O/"Search archives".
  363.  
  364.     * Results can be saved in a file.
  365.  
  366.     * If the "Persistent search result" checkbox is checked, Nemo will
  367.       keep in memory the results of the last search. They can be recalled
  368.       as many times as needed through the Shift-Alt-F7 key combination.
  369.  
  370.     Command line
  371.     ------------
  372.     Alt-Enter, Alt-Home and Ctrl-Alt-Enter paste the current directory
  373.     name into command line. The last two combinations are useful when
  374.     running the DOS version of Nemo under Windows, which usually
  375.     catches the Alt-Enter key combination.
  376.  
  377.     Shift-Enter executes the current line preceeded by a user-defined
  378.     (F9/O/H) prefix, "start " by default in OS/2 version and "loadfix "
  379.     in the DOS one. This is also valid for executing extension-defined
  380.     commands. Shift-Enter over a non-executable filename will first
  381.     construct the command according to the directive in the extension
  382.     file, then execute it with the prefix.
  383.     
  384.     Nemo catches all "CD", "X:" and "SET variable[=value]" operations
  385.     performed on the command line and interprets them internally.
  386.     "CD..." acts like "CD ..\..". In the Unix version "cd ~" and "cd
  387.     ~login_name" are interpreted as well.  The errors resulting from
  388.     such operations are displayed using the standard system messages,
  389.     for full ordinary command processor illusion.
  390.  
  391.     Ctrl-Enter never completes the current command given the past
  392.     history, and always pastes the current panel entry into the line.
  393.     Use Shift-Ctrl-Enter to complete the command line using history.
  394.  
  395.     Ctrl-^ changes the current directory to the one indicated by the
  396.     HOME environment variable. Note that on non-US keyboards this key
  397.     combination may vary. Try Ctrl-6 first.
  398.  
  399.     Tree panels and NCD
  400.     -------------------
  401.     Support the long file names, logical file names and offer
  402.     appropriate as-required horizontal scrolling. The display model in
  403.     NCD is somewhat different from the NC one, in that Nemo tries to
  404.     save the screen real-estate, does not round up directory names to 12
  405.     chars, does not align directories of same depth vertically and does
  406.     not use wasteful in-field arrows, but rather out-of-field
  407.     scrollbars.
  408.  
  409.     Trees are always displayed (and saved on disk) sorted, either case-
  410.     sensitively or case-insensitively, depending on the F9/O/N option.
  411.  
  412.     Directory trees of CD-ROMs or read-only diskettes are cached on the
  413.     hard disk, so as to allow operation of tree panels and NCD with these
  414.     media, without re-reading the disk all the time as NC does. You do
  415.     not need to have treeinfo.ncd files on CD-ROMs for proper Tree
  416.     operation with them.
  417.     
  418.     The file containing the directory tree information is kept hidden.
  419.     It is also named nemo.tre (.nemo.tre on Unix) since its format
  420.     is different from the treeinfo.ncd one.
  421.  
  422.     Changing the current directory with Nemo
  423.     ----------------------------------------
  424.     If passed the "/d <filename>" option, Nemo will print a command file
  425.     named <filename> and allowing to set the current disk and directory
  426.     to the last current disk and directory of Nemo.
  427.  
  428. These features are shared with the reference program:
  429.  
  430.     - <auto>    a 100% NC for DOS v.2-v.4 look including colors;
  431.     - F9/[LR]/B    "Brief" and
  432.       F9/[LR]/L    "Long" directory formats for FAT disks;
  433.     - <auto>    fully functional command line editor, also in all
  434.             dialog boxes, including a "hysteresis" backscroll.
  435.     - <auto>    interaction between panels and command line,
  436.       ^Enter    including filename pasting
  437.     - <auto>    full and unlimited length extension file nemo.ext
  438.             with !, .!, !:, !\ and !! handling;
  439.     - X:   CD..    transparent capture of disk and directory changes
  440.       CD\  CD    and display performed using the command line.
  441.       CD <dir>    Error messages are native OS/2 messages for
  442.             full OS/2 CMD.EXE illusion;
  443.  
  444.     - INS         file tagging, preserved between shell command
  445.             execution and pane hiding;
  446.     - DEL        char deletion;
  447.     - grey-        file untagging by mask;
  448.     - grey+        file tagging by mask;
  449.     - Alt-...    file selecting by initials;
  450.     - arrows    operate differently according to the
  451.             type of the current pane, if any;
  452.     - HOME/END    operate  differently according to
  453.             the type of the current pane, if any;
  454.     - PageUp/Down    100% NC's funny logic;
  455.  
  456.     - F1        display help page;
  457.     - F2        nemo.mnu user menu, local and global;
  458.     - F3        viewer (can be disabled and set to an external
  459.             executable through Options/Viewer);
  460.     - F4        external editor (name can be set through a
  461.             Options/Editor);
  462.     - F5        file copying, individual and tagged, with
  463.             full wildcard support and full set of
  464.             informational and error messages;
  465.     - F6        file moving, directory renaming, with full
  466.             wildcard support and full set of informational
  467.             and error messages;
  468.     - F7        directory creation;
  469.     - F8        file/dir deletion, individual and tagged;
  470.     - F9        activate menu bar, turn on "Left" or "Right"
  471.             accordingly to the current panel;
  472.     - F10        quit
  473.  
  474.     - Alt-F1    disk selection
  475.     - Alt-F2    disk selection
  476.     - Alt-F3    view currently selected file using alternate viewer
  477.     - Alt-F4    edit currently selected file using alternate editor
  478.     - Alt-F5    Toggle usage of logical names
  479.     - Alt-F6    Toggle 132 column mode vs. 80 column mode
  480.     - Alt-F7    Find file
  481.     - Alt-F8    history box
  482.     - Alt-F9    43/50 lines
  483.     - Alt-F10    Display directory tree
  484.  
  485.     - Shift-F1    <no action>
  486.     - Shift-F2    <no action>
  487.     - Shift-F3    arbitrary file viewing
  488.     - Shift-F4    arbitrary file editing
  489.     - Shift-F5    file copying/renaming by mask
  490.     - Shift-F6    file moving/renaming by mask
  491.     - Shift-F7    directory creation
  492.     - Shift-F8    file/dir deletion
  493.     - Shift-F9    save nemo.ini binary config file
  494.     - Shift-F10    open the last used menu and set the selection bar
  495.             on the last command selected.
  496.  
  497.     - Ctrl-F1    turning left pane on/off
  498.     - Ctrl-F2    turning right pane on/off
  499.     - Ctrl-F3    make current panel Directory, sort by Name
  500.     - Ctrl-F4    idem, but sort by Extension
  501.     - Ctrl-F5    idem, but sort by Time
  502.     - Ctrl-F6    idem, but sort by Size
  503.     - Ctrl-F7    idem, but do not sort
  504.     - Ctrl-F8    <no action in NC, reverse sorts in Nemo>
  505.     - Ctrl-F9    <no action>
  506.     - Ctrl-F10    <no action>
  507.  
  508.     Ctrl-key combinations:
  509.     - ^A        word left
  510.     - ^B        keybar switching
  511.     - ^C        no action in command line, page down in editor
  512.     - ^D        one char forward
  513.     - ^E        previous history entry in command line, line up
  514.             in editor and in viewer
  515.     - ^F        word right
  516.     - ^G        delete char under cursor
  517.     - ^H        backspace
  518.     - ^I        switch to other panel if any
  519.     - ^J        paste pane selection into command line
  520.     - ^K        killing line end
  521.     - ^L        info panels
  522.     - ^M        execute command line
  523.     - ^N        open menu bar and select current panel menu
  524.     - ^O        panels on/off
  525.     - ^P        non-current pane switching
  526.     - ^Q        toggles the Quick View mode of opposite panel
  527.     - ^R        changing disk for current pane in command line,
  528.             page up in editor
  529.     - ^S        one char backward
  530.     - ^T        delete word right
  531.     - ^U        swap panels
  532.     - ^W        delete word left
  533.     - ^X        next history entry in command line, line down in editor
  534.             and in viewer
  535.     - ^Y        delete command line
  536.     - ^Z        <no action>
  537.     - ^Home        goto start of line
  538.     - ^End        goto end of line
  539.     - ^BS        delete word right (same funny semantics
  540.             for finding the char to stop on as in NC)
  541.  
  542.     - F9/[LR]/B    brief directory format
  543.     - F9/[LR]/F    full directory format
  544.     - F9/[LR]/I    information
  545.     - F9/[LR]/O    pane on/off switching
  546.     - F9/[LR]/[NXSMU]
  547.             all sorting options
  548.     - F9/[LR]/R    directory re-read
  549.     - F9/[LR]/D    drive selection
  550.  
  551.     - F9/F/H    help
  552.     - F9/F/U    user menu
  553.     - F9/F/V    view file
  554.     - F9/F/E    edit file
  555.     - F9/F/C    copy files
  556.     - F9/F/M    move files
  557.     - F9/F/M    make directory
  558.     - F9/F/D    delete files/directory
  559.     - F9/F/G    tag group of files by mask
  560.     - F9/F/N    untag group of files by mask
  561.     - F9/F/I    invert tagged status of files by mask
  562.     - F9/F/Q    quit NEMO
  563.  
  564.     - F9/C/H    history menu
  565.     - F9/C/E    EGA lines
  566.     - F9/C/S    swap panels
  567.     - F9/C/L    toggle 132 column mode
  568.     - F9/C/.    toggle logical name usage
  569.     - F9/C/P    panels on/off
  570.     - F9/C/C    compare directories (warning: like in NC, comparing is
  571.             only on existence/date/time. Not on size, attributes
  572.             nor EAs.)
  573.     - F9/C/M    menu file edit
  574.     - F9/C/X    extension file edit
  575.  
  576.     - F9/O/C    color dialog box
  577.     - F9/O/C/B    black and white display mode
  578.     - F9/O/C/C    color display mode
  579.     - F9/O/C/L    laptop display mode
  580.     - F9/O/A    auto menus on/off
  581.     - F9/O/P    path prompt switching vs. disk-only prompt
  582.     - F9/O/K    key bar on/off
  583.     - F9/O/F    full screen vs. half screen
  584.     - F9/O/I    ins moves down on/off
  585.     - F9/O/L    clock on/off
  586.     - F9/O/V    viewer selection
  587.     - F9/O/V/B    built-in viewer selection
  588.     - F9/O/V/E    external viewer selection and defining
  589.     - F9/O/E    editor selection
  590.     - F9/O/E/B    built-in editor selection
  591.     - F9/O/E/E    external editor selection and defining
  592.     - F9/O/R    screen-saver time-out adjusting
  593.     - F9/O/N    case-sensitive file sorting
  594.     - F9/O/T    reverse file sorting
  595.     - F9/O/H    Shift-Enter prefix definition
  596.     - F9/O/S    save setup
  597.  
  598. Archive format support
  599. ----------------------
  600. Except for reading the archive directories, Nemo performs all archive
  601. operations using external tools, constructing commands with the help
  602. of the nemo-os2.ARV file. Care has been taken to ensure the
  603. best possible operation with all supported archive types. Some archive
  604. handling tools have resisted however, and therefore some operations are
  605. not possible with particular archive types. Below are remarks for each
  606. archive format. The following points are developped:
  607.  
  608.     - Versions of format supported (only the archive directory format
  609.       is relevant and discussed);
  610.     - Version of tools required for proper Nemo operation;
  611.     - Support for the basic I/O operations: copy-in, copy-out,
  612.       mkdir, rmdir, unlink, empty-archive-creation;
  613.     - Support for attributes, OS/2 EAs, passwords;
  614.     - Ability to process archives with unusual extensions.
  615.  
  616.     ARC/PAK
  617.     Versions: the ARC subset
  618.     DOS tools: pkpak + pkunpak 3.61
  619.     OS/2 tools: arc 5.21
  620.     Supported: copy-in, copy-out, unlink, empty-archive-creation
  621.     Unsupported: mkdir, rmdir, file attributes, EAs
  622.     Notes: ARC files do not support directories. Extensions to the
  623.         format made by NoGate, which gave the PAK format, are not
  624.         supported at this time. Given the way they have been
  625.         implemented, they should in no way harm the proper operation
  626.         of Nemo. Nemo will recognize PAK files as ARC files.
  627.  
  628.     ARJ
  629.     Versions: all
  630.     DOS tools: ARJ 2.21, ARJ 2.41
  631.     OS/2 tools: UNARJ (+ ARJ for DOS)
  632.     Supported: copy-in (DOS), copy-out, empty-archive-creation,
  633.         file attributes, passwords (DOS), self-extracting archives
  634.     Unsupported: any editing (OS/2), EAs (OS/2)
  635.  
  636.     FTP
  637.     Versions: irrelevant, Nemo uses its own description of an FTP site
  638.     Tools: any FTP client accepting command files or input redirection
  639.     Supported: copy-in, copy-out, mkdir, rmdir, unlink
  640.     Unsupported: file attributes, EAs
  641.     Notes: you are limited to a single directory per description file.
  642.  
  643.     GZIP
  644.     Versions: all
  645.     DOS tools: GZIP 1.2.4
  646.     OS/2 tools: GZIP 1.2.4
  647.     Supported: copy-out, copy-in, unlink, empty-archive-creation
  648.     Unsupported: file attributes, EAs, mkdir, rmdir.
  649.  
  650.     LZH
  651.     Versions: levels 1, 2 and 3
  652.     DOS tools: LHA 2.13
  653.     OS/2 tools: LH2 2.22 by Peter Fitzsimmons
  654.     Supported: copy-in, copy-out, empty-archive-creation, file
  655.         attributes, EAs.
  656.     Unsupported: mkdir (but format does support them, it is just a problem
  657.         with existing LZH tools).
  658.     Notes: Since the LZH format does not support empty archives,
  659.         a fake, zero-sized hidden file named ROOT is put into the
  660.         archive when created.
  661.  
  662.     OS/2 UNPACK
  663.     Versions: 1.1, 1.2, 1.3, 2.0, 3.0
  664.     OS/2 tools: UNPACK and UNPACK2 provided with OS/2
  665.     Supported: copy-out, file-attributes, EAs
  666.     Unsupported: copy-in, empty-archive-creation, mkdir, rmdir, unlink
  667.     Notes: I do not know which tools can create UNPACK archives.
  668.  
  669.     TAR
  670.     Versions: the ANSI ASCII tar(1) format
  671.     DOS tools: any which follows the Unix command format
  672.     OS/2 tools: idem
  673.     Supported: copy-out
  674.     Unsupported: copy-in, mkdir, rmdir, unlink, empty-archive-creation, EAs
  675.     Notes: No tool seems to be able to add files to an existing TAR
  676.         archive. I have not tried the GTAK package yet.
  677.  
  678.     UNIX ls(1) directory listing
  679.     Versions: both System V and BSD variants. Nemo applies various
  680.        heuristics to decode variations of the basic formats.
  681.     DOS tools: irrelevant
  682.     OS/2 tools: irrelevant
  683.     Supported: irrelevant
  684.     Unsupported: irrelevant
  685.     Notes: 1/ Obviously you can only view the listing (in directory
  686.         panels, tree panels, file-find, Alt-F10). No file operations
  687.         are possible as there is no file data stored.
  688.         2/ Reading this format is relatively slow, since the information
  689.         needs to be converted from ASCII to a binary format.
  690.  
  691.     ZIP
  692.     Versions: DOS, OS/2, Unix and Windows NT-created files
  693.     DOS tools: PKZIP 2.04g
  694.     OS/2 tools: Info-Zip Zip/Unzip 2.x
  695.     Supported: copy-in, copy-out, mkdir, rmdir, unlink, empty-archive-
  696.         creation, file-attributes, EAs, passwords (if your version of
  697.         Unzip supports pssing them on the command line, otherwise you
  698.         will need to set the $G flag and enter them on the command line),
  699.         arbitrary size comments attached to archives.
  700.  
  701.     ZOO
  702.     Versions: header types 1 and 2
  703.     DOS tools: ZOO 2.1
  704.     OS/2 tools: ZOO 2.1
  705.     Supported: copy-in, copy-out, rmdir, unlink
  706.     Unsupported: mkdir
  707.  
  708. Known bugs
  709. ----------
  710. Known bugs are listed in the 'bugs.doc' file.
  711.  
  712. Remarks and hints
  713. -----------------
  714.   [1]    Nemo always uses DOS file selection mechanism, ie. the last dot
  715.     of a file name is considered as "the" dot and the other are seen
  716.     as ordinary chars.
  717.  
  718.   [2]    OS/2 locks files and directories when used or current for a
  719.     process, so you cannot remove them, nor change their physical
  720.     or logical names.
  721.  
  722.   [3]    Use ^ in logical names to obtain a newline effect on the WPS
  723.     desktop. You can even enter the ^ in the WPS, and as soon as
  724.     you validate the name change it will be transformed into a
  725.     visual newline.
  726.  
  727.   [4]    Logical name support is still incomplete and somewhat
  728.     incoherent. Physical names are never updated when logical
  729.     ones are changed. It is possible to have two files under the
  730.     same logical name, for example when copying a non-8.3 file
  731.     from an HPFS disk to a FAT disk and then back. Basically,
  732.     Nemo considers the logical name merely as a title and
  733.     shows it everywhere where a title can be shown.
  734.  
  735.   [5]    If you want an arbitrary number of screen lines (columns
  736.     must be either 80 or 132), execute the OS/2 "MODE" command
  737.     before or from within Nemo.
  738.  
  739.   [6]    It is not possible to have 132 columns in a window under pre-Warp
  740.     versions of OS/2. This was a limitation of OS/2 windowed sessions.
  741.  
  742.   [7]    A command file (.CMD) executed from within Nemo cannot modify
  743.     Nemo's current disk, nor directory. This is because Nemo executes
  744.     the .CMD file in a separate child process and child processes
  745.     don't communicate their current disk/directory to their parent
  746.     on exit. I don't plan to incorporate a .CMD file interpreter
  747.     into Nemo right now.
  748.  
  749.     If you want to use Nemo to change the current directory, you
  750.     need to call it from a .CMD command file, and use the /d<filename>
  751.     option described above. See the provided nemo2.cmd script for an
  752.     example. This will not work from within Nemo itself (cf. the previous
  753.     paragraph), but it will work from CMD.EXE.
  754.  
  755.   [9]    The initial message box will not be displayed if Nemo founds
  756.     a 'nemo.ini' setup file.
  757.  
  758.   [10]    The viewer uses different display algorithms when scrolling
  759.     backward and when scrolling forward. This may change the appearance
  760.     of lines which are over 78 characters. NC exhibits similar
  761.     differences.
  762.  
  763.   [11]    While the current disk and directory are saved in nemo.ini for both
  764.     panels, those for the current panel will be ignored at startup
  765.     time. Nemo's current panel will inherit the disk and directory of
  766.     the parent process.
  767.  
  768.     If you want to force a specific initial directory, or to set a
  769.     specific number of screen lines of columns, you can call NEMO from
  770.     a batch file (.CMD), after using "CD," disk change and "MODE"
  771.     commands. This approach works even when Nemo is the primary shell
  772.     (SET RUNWORKPLACE=nemo.cmd), since the primary shell can be a .CMD
  773.     file. Using a batch file as primary shell will also allow to
  774.     dynamically switch the real shell (without rebooting the machine).
  775.     Just edit the .CMD file, which is not locked by OS/2, exit from the
  776.     first shell and OS/2 will start the new one.
  777.  
  778.   [12]    The provided setlname.exe utility can be used to attach a logical
  779.     name (.LONGNAME extended attribute) to a file.
  780.  
  781.   [13]    When working inside file archives, please remember that you are
  782.     operating directly on archive files themselves and not on a
  783.     temporarily extracted set of files, so for example any delete
  784.     operation will be applied to the content of the archive itself,
  785.     immediately. Be careful with Grey+ and *.*.
  786.  
  787.     If you delete some files by accident, you may either try to use
  788.     OS/2 undelete facilities to recover the archive file itself, or you
  789.     may try to look into the Nemo cache directory for the files you
  790.     have opened previously. Note that only files previously opened for
  791.     reading will appear in the cache; if you delete a file from an
  792.     archive without having read it previously, you can only recover the
  793.     archive itself.
  794.  
  795.     Nemo forbids modifying read-only archives. This is managed at a low
  796.     level and not always very obvious in upper layers, due to NC message
  797.     box compatibility requirements. If you encounter a situation where Nemo
  798.     refuses to perform an archive operation without giving a clear
  799.     reason, think about the possibility of the archive being read-only.
  800.  
  801.     Use recent versions of archivers. Nemo might be able to read the
  802.     directory of an archive, which could not be processed by your
  803.     version of the archiver.
  804.  
  805.   [14]    The VFS cache should be located on an HPFS filesystem, or you might
  806.     not be able to access files whose name does not conform to the 8.3
  807.     model.
  808.  
  809.   [15]    When you rename a file and want to have the old name as the default
  810.     new name, just turn off the opposite panel first.
  811.  
  812. Acknowledgements
  813. ----------------
  814. Benoit Poulot and Kai Uwe Rommel helped me quite a bit during the
  815. development.
  816.  
  817. The following people have provided bugs reports, ideas and
  818. (sometimes clinking) encouragements:
  819.  
  820. Henk den Adel        Neil Aggarwal        Heiko Amft
  821. Sébastien Bellefeuille    Francois Bernhard    Martin Borstom
  822. Thomas Bradford        Egons Bush        Harry Bush
  823. H. Choe            Jim Davee        Michael DeMutis
  824. Karl-Heinz Dewi        Andy Elkin        Michel Ferland
  825. Oscar M. Fowler        Henning Fuchs        Frans Goddijn
  826. Simon Goland        Kordt Griepenkerl    Ralf Grohmann
  827. Brian Grunkemeyer    Anthony Guetmansky    Jon Hacker
  828. Günter Hahn        Philippe Huybrechts    Harald Ibener
  829. Paul Ingram        Alex Jastrebzew        Richard Johnston
  830. Lars Jorgensen        Eduard Kappel        Howard Kapustein
  831. Jari Laaksonen        Christian Laubscher    Guylain Lavoie
  832. Alex Le Dain        Michael Lenzen        Marc Levy
  833. Magnus Lövkvist        Leon Loo        Sanjay Madhavan
  834. Lester Stephen Mah    Francis Martin        James Mehl
  835. Leo V. Mironoff        Mark Nixon        Max Obkirchner
  836. Jan Otterstedt        Florian Piekert        Roman Prikryl
  837. Matthias Rabe        Christian Rettner    Ulf Sassenberg
  838. Jens Schlatter        Uwe Schlenther        Roland Schorr
  839. Gottfried Schottky    Dan Soussi        Richard Stanton
  840. Ronald Steinhoff    Morio Taneda        Andreas Tille
  841. Eric Trepanier        Paul Tylich        Thomas Vandahl
  842. Alfred Vink        William T. Warner, Jr.    Herbert Weinhandl
  843. Joern Wellhausen
  844.  
  845. Paul Tylich is the author of nemo1.ico alternate Captain Nemo icon,
  846. while Lester Stephen Mah is the author of nemo2.ico and nemo3.ico.
  847.  
  848. Trademarks
  849. ----------
  850. "Norton Commander" (R) is a registered trademark of the
  851. Symantec Corporation.
  852.  
  853. $Id: nemo.DOC 1.62 96/02/06 04:31:50 ROOT_DOS Exp $
  854.  
  855.